home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / batchut / ben250.zip / BEN.DOC next >
Text File  |  1990-01-04  |  42KB  |  946 lines
  1.           ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  2.           ▒                                                        ▒
  3.           ▒                                                        ▒
  4.           ▒                                                        ▒
  5.           ▒               BEN - the Batch ENhancer                 ▒
  6.           ▒               ────────────────────────                 ▒
  7.           ▒                                                        ▒
  8.           ▒           Version 2.50 (c) Simvis Soft 1990            ▒
  9.           ▒                    Author Simon Lee                    ▒
  10.           ▒                                                        ▒
  11.           ▒                                                        ▒
  12.           ▒                                                        ▒
  13.           ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  14.           
  15.           
  16.           This program is distributed under the Shareware scheme. You
  17.           are encouraged to give copies of this program to other
  18.           computer users. If you decide to use the program, support
  19.           the Shareware marketing concept by becoming a registered
  20.           user. Read the appendix for more details. Please read the
  21.           entire manual for your understandings of BEN. If you are
  22.           unable to do that, at least read section 2.1.
  23.           
  24.           ───────────────────────────────────────────────────────────
  25.           
  26.           1.1 What is BEN?
  27.           BEN stands for the Batch ENhancer:
  28.           
  29.           *BATCH*
  30.           Batch is a very simple yet powerful language DOS adapted.
  31.           However, it is very weak in some fields, such as the
  32.           inabilities to display color or input strings from user.
  33.           
  34.           *ENHANCER*
  35.           This program enhances the Batch language (as you know, batch
  36.           files end with the extension of .BAT)
  37.           The objective of this utility is to overcome the BATCH
  38.           weaknesses. Here is a rough list of what BEN can do:
  39.           - Sound: Music, beeps, etc.
  40.           - Boxes: growing, filled, shadowed, invisible, etc.
  41.           - Display strings: centered, vertical, etc.
  42.           - Displaying: EGA/VGA 43/50 lines mode, colors, etc.
  43.           - Sidekick Plus style directory.
  44.           - Input from user: key, line, upper cased line.
  45.           - Pause the computer for a certain period of time.
  46.           - Scrolling.
  47.           To see these features, go back to the DOS prompt and run
  48.           BENDEMO.BAT, and keep in mind that what you will see is only
  49.           a batch file.
  50.           
  51.           ───────────────────────────────────────────────────────────
  52.           
  53.           1.2 Requirements:
  54.           IBM PC/Compatible with PC/MS-DOS 2.1 or higher.
  55.           (3.3 or higher recommended. If you are using a version lower
  56.            than 3.3, whenever in this document the command "CALL" is
  57.            used, change it to "COMMAND /C".)
  58.           
  59.           Optional: ANSI.SYS or equivalent.
  60.           
  61.           (Note: ANSI is a computer standard that every user should
  62.           have. If you did not install it yet, BENDEMO.BAT will not
  63.           run properly; and the option COLORNOW is diminished.
  64.           Therefore ANSI is highly recommended. ANSI.SYS is included
  65.           with all PC/MS-DOS. If you require aid in installing, please
  66.           refer to the appendix.)
  67.           
  68.           ───────────────────────────────────────────────────────────
  69.           
  70.           2.1 Command Parameters
  71.           
  72.           Command: [d:][path]BEN.EXE [options][options...]
  73.           The first [d:][path] specifies the pathname for BEN.
  74.           You can stack as many options on one line as the environment
  75.           can hold. For example, "BEN DELAY 3000 ATTRIB 7 0" is a
  76.           command line with 2 options. Just enter options one after
  77.           another. Each option has several parameters which you will
  78.           need to pass to it. In this case, they are 3000, 7 and 0.
  79.           The above line is exactly the same as:
  80.           
  81.           BEN DELAY 3000                } 3000  are the
  82.           BEN ATTRIB 7 0                } 7, 0  parameters.
  83.           
  84.           Note: Never stack several options that uses BENBAT on a
  85.                 single line of command. They are identified with an
  86.                 asterisk (*) following on.
  87.                 Anything after the ECHO option is thought to be
  88.                 parameters, therefore never use any option after using
  89.                 ECHO on one command line.
  90.           
  91.           Options: (briefly discussed:)
  92.           
  93.           Upper case = mandatory words.
  94.           Lower case = parameters which need substitution.
  95.           [in bracket] = optional parameters.
  96.           
  97.           
  98.           (No option entered)
  99.           Just by typing BEN will provide you with few help screens.
  100.           Also, the UNREGISTERED message will only appear in this
  101.           section of BEN.
  102.           
  103.           1> ASK options <────── (Such as this. "options" is a parameter.)
  104.              This command wait for the user to press a key, and return an
  105.              errorlevel according to the key.
  106.           
  107.           2> ATTRIB fground bground
  108.              Clears the screen with the specified colors.
  109.           
  110.           3> BEEP
  111.              Creates a "beep" sound.
  112.           
  113.           4> BOX x1 y1 x2 y2 fground bground bordertype boxtype
  114.              Creates a box on the screen.
  115.           
  116.           5> COLORNOW fground bground
  117.           *  Changes the current writing color.
  118.           
  119.           6> CURSOR [ON][OFF]
  120.              Shows or hides the text cursor.
  121.           
  122.           7> DIRDISP directory return
  123.           *  Displays a SideKick Plus style directory and allows the user
  124.              to select a file or change directories.
  125.           
  126.           8> DELAY milliseconds
  127.              Delays the computer for a certain period of time.
  128.              (Note: 1 second = 1000 milliseconds.)
  129.           
  130.           9> ECHO fground bground word1 [word2...]
  131.              Writes a string onto the screen. Identical to the DOS ECHO.
  132.           
  133.           10> EGAVGA [ON][OFF]
  134.               Turns the EGA/VGA 43/50 lines mode on or off.
  135.               The presence of EGA/VGA is passed into the DOS errorlevel:
  136.               0 = No, 1 = Yes.
  137.           
  138.           11> GOTOXY x y or
  139.               GOTOXY T textfile
  140.               Goes to the certain part of the screen as specified in x and y.
  141.           
  142.           12> INLINE
  143.           *   Inputs a line of string from user.
  144.           
  145.           13> INLINEU
  146.           *   Inputs a line of string from user, and convert it to
  147.               upper case.
  148.           
  149.           14> INKEY
  150.           *   Inputs a character from the user.
  151.           
  152.           15> MENU title totalchoices choice1 [choice2...]
  153.           *   Displays a manual on the screen, and allow the user to select
  154.               a choice.
  155.           
  156.           16> SOUND frequency duration [frequency duration...] or
  157.               SOUND T textfile
  158.               This option is used to play music.
  159.           
  160.           17> SCROLL x1 y1 x2 y2 direction or
  161.               SCROLL T textfile
  162.               Scrolls text on the screen in any of the four directions.
  163.           
  164.           18> T textfile
  165.               Uses a data file to perform BEN jobs OPTIMIZED!
  166.           
  167.           19> WRITE fground bground wordcount word1 [word2...]
  168.               Displays a string onto the screen.
  169.           
  170.           20> WRITEC fground bground wordcount word1 [word2...]
  171.               Displays a centered string onto the screen.
  172.           
  173.           21> WRITEV x y fground bground wordcount word1 [word2...]
  174.               Displays a vertical column of string onto the screen.
  175.           
  176.           
  177.           * - returns from BEN is passed into BENBAT.BAT. When it is
  178.               called, the value is then passed into the environment
  179.               variable "BEN", in which the batch file can access.  For
  180.               more details abou